Skip to content

Conversation

@guineveresaenger
Copy link
Contributor

First outline of blog announcing environment variable remappings for providers

@claude
Copy link
Contributor

claude bot commented Feb 5, 2026

Documentation Review

This blog post draft announces a new environment variable remapping feature for providers. Here are my findings:

Critical Issues

1. Incomplete code example (line 55)
The placeholder text "Example (make it in all languages)" and "TODO: give example code" needs to be replaced with actual working code examples. Blog posts should show concrete, realistic examples in multiple Pulumi languages (TypeScript, Python, Go, C#, Java, YAML).

Provide a complete multi-language code example showing how to use the `EnvVarMappings` resource option. For example:

**TypeScript:**
```typescript
const provider = new azure.Provider("my-provider", {
    envVarMappings: {
        "ARM_CLIENT_SECRET": "MY_CUSTOM_SECRET_VAR",
    },
});

Python:

provider = azure.Provider("my-provider",
    env_var_mappings={
        "ARM_CLIENT_SECRET": "MY_CUSTOM_SECRET_VAR",
    })

**2. Missing version number (line 21, 59)**
- Line 21: "From Pulumi version (TODO: version)"
- Line 59: "Available in Pulumi version 1.250.awesome and higher"

Replace these with the actual Pulumi version when this feature becomes available.

**3. Leftover template text (lines 61-66)**
Lines 61-66 contain boilerplate instructions from the blog post template that should be removed entirely:

Main content goes here. Everything after the comment appears only on the full post page.

Avoid using images or code samples in the first 70 words, as they may not render properly in summaries.

For more guidance, see BLOGGING.md.


Delete these lines before publishing.

### Style and Clarity Issues

**4. Backtick in bash example (line 36)**
Line 36 has a misplaced backtick at the end:
```bash
export ARM_CLIENT_SECRET=1234567`

Should be:

export ARM_CLIENT_SECRET=1234567

5. Unclear feature description (line 52-53)
The quote "For any environment variable that my provider expects, I want to be able to tell Pulumi to use the value of a custom-defined environment variable instead" could be clearer. Consider rephrasing to:

"I want to define custom environment variable names and map them to the standard environment variables that my provider expects. This allows me to set different values for each provider instance."

6. Heading capitalization (line 41)
The H2 heading on line 41 should use sentence case per the style guide:

  • Current: "Multiple providers or provider instances that expect different authentication values"
  • Suggested: "Multiple providers or provider instances that expect different authentication values" (already correct, but verify no other headings need adjustment)

7. Enhance the introduction
The opening paragraphs (lines 19-23) could be stronger. Consider adding a concrete problem statement before jumping into the solution. For example:

Have you ever needed to use multiple AWS providers in the same Pulumi program, each authenticating to a different account? Or run both Azure Native and Azure Classic providers with different credentials? Until now, this wasn't possible using environment variables alone.

From Pulumi version [VERSION], you can now define your own environment variables and remap them to existing provider environment variables, allowing you to set them to multiple different values when running multiple providers in the same process.

Documentation Gap

8. Missing supporting documentation
This blog post announces a new feature, but I found no corresponding documentation in content/docs/ explaining how to use EnvVarMappings. Before publishing this blog post, you should:

  1. Add documentation to content/docs/iac/concepts/options/ or similar location explaining:

    • What environment variable remapping is
    • When to use it
    • Complete API reference for the resource option
    • Multiple working examples in all Pulumi languages
    • Common use cases (multi-region AWS, dual Azure providers, etc.)
    • Any limitations or gotchas
  2. Consider adding a tutorial or guide showing a complete example (e.g., "Deploy to Multiple AWS Regions with Environment Variable Remapping")

  3. Set the blog post's canonical_url frontmatter to point to the docs page once created, so the docs become the primary source of truth for search engines.

Meta Image Verification

The PR includes a meta.png file. Please verify:

  • It's exactly 1200×630 pixels
  • Any logos used are current and up-to-date (especially important per BLOGGING.md guidelines)
  • It includes at least one Pulumi identifier
  • Important elements aren't too close to the edges

Social Media Fields

The frontmatter includes empty social fields for Twitter and LinkedIn. Either populate these with promotional copy or remove the empty section before publishing.


Summary

This is a good start on announcing an exciting new feature! The main blockers are:

  1. Complete the code examples with real, working multi-language samples
  2. Fill in the version numbers
  3. Remove the template boilerplate text
  4. Create supporting documentation before publishing

Once these are addressed, this will be ready for publication. Great work explaining a complex authentication scenario in an accessible way!

Next steps: Mention @claude if you'd like help implementing any of these suggestions or creating the supporting documentation.

@pulumi-bot
Copy link
Collaborator

@guineveresaenger guineveresaenger self-assigned this Feb 6, 2026
@guineveresaenger guineveresaenger added this to the 0.132 milestone Feb 6, 2026
@pulumi-bot
Copy link
Collaborator

@guineveresaenger guineveresaenger changed the title [WIP] Announce EnvVarMappings resource option Announce EnvVarMappings resource option Feb 10, 2026
@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@guineveresaenger guineveresaenger marked this pull request as ready for review February 10, 2026 01:39
@guineveresaenger guineveresaenger changed the title Announce EnvVarMappings resource option Documentation and blog announcement for EnvVarMappings resource option Feb 10, 2026
@claude
Copy link
Contributor

claude bot commented Feb 10, 2026

Documentation Review

I've reviewed the new envVarMappings resource option documentation and blog post. Overall, the content is well-structured and clearly explains the feature. Below are my findings:

Issues Found

Blog Post (content/blog/new-provider-resource-option-environment-variable-remapping/index.md)

  1. Line 64: Typo - "setits" should be "set its" (missing space)

  2. Line 64: Double space before closing backtick - "your special CUSTOM_ARM_CLIENT_SECRET" should have single space

  3. Blog structure: The blog post lacks a clear call-to-action at the end. Consider adding something like "Try it out today by upgrading to Pulumi 3.220.0 or later" or pointing readers to specific next steps.

  4. Example clarity: In line 58-64, the explanation could be clearer about the direction of the mapping. Consider rephrasing to make it more explicit how the mapping works.

Documentation Page (content/docs/iac/concepts/resources/options/envvarmappings.md)

  1. Line 24: Typo - "environnment" should be "environment" (extra n)

  2. Line 362: The file appears to end without a trailing newline. All Markdown files must end with a newline per AGENTS.md.

  3. Line 351: "Limitations" section mentions "One-way mapping: Each custom variable maps to exactly one provider variable." This seems to contradict the multi-provider example where multiple custom vars map to the same provider variable names (just on different provider instances). Consider clarifying this means "on a single provider instance" or rewording for clarity.

Index File Update (content/docs/iac/concepts/resources/options/_index.md)

  1. Line 29: The link path uses /docs/concepts/options/envvarmappings/ but according to the aliases in the new file, the canonical path should be /docs/iac/concepts/resources/options/envvarmappings/. While the alias will redirect, using the canonical path is clearer.

Suggestions

  1. Blog opening: The opening could be stronger. Consider starting with the problem statement before announcing the solution.

  2. Code examples: All code examples follow the proper multi-language chooser pattern, which is excellent. The examples are realistic and helpful.

  3. Cross-linking: The blog post correctly links to the documentation, and the documentation is properly integrated into the options index. Good job on the cross-referencing.

  4. Terminology consistency: The document consistently uses "environment variable" and "provider" terminology correctly throughout.

  5. Missing documentation check: This feature announcement is well-supported by comprehensive documentation. The docs include clear use cases, examples, and limitations. No additional documentation appears needed.

Summary

The documentation and blog post effectively explain the new envVarMappings feature. The primary issues are:

  • Two typos ("setits" and "environnment")
  • Missing trailing newline on the documentation page
  • Minor clarity improvements needed in the limitations section
  • Consider strengthening the blog post's opening and closing

Once these issues are addressed, this will be ready to merge.


Mention @claude if you'd like me to review the fixes or need additional assistance.

@pulumi-bot
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants